Add structures::gdt::Entry type #380
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current documentation for the GDT often confuses entries and `Descriptor`s.
For example, adding a new `Descriptor` uses a method confusingly named
`add_entry`.
An entry is a raw 64-bit value that is indexed by a segment selector.
The `MAX` length of the GDT is a number of _entries_, not `Descriptor`s.
To fix this confusion, this PR makes the following changes:
- Adds a transparent `u64` newtype called `Entry`.
- Updates the `GlobalDescriptorTable` documentation to correctly use
`Entry` or `Descriptor` where appropriate.
- Renames the `add_entry` to `append`.
- This better expresses that this method might add multiple entries.
- Renames `from_raw_slice` to `from_raw_entries`
- Renames `as_raw_slice` to `entries`
- This method now returns a slice of `Entry`s instead of `u64`s
This also fixes an issue where our `assert!`s in `empty()` wouldn't
trigger if the GDT was constructed from raw values.
Signed-off-by: Joe Richey <[email protected]>
Freax13
requested changes
Apr 15, 2022
Signed-off-by: Joe Richey <[email protected]>
Also update the documentation Signed-off-by: Joe Richey <[email protected]>
Freax13
requested changes
Apr 15, 2022
Freax13
reviewed
Apr 15, 2022
Freax13
reviewed
Apr 15, 2022
Signed-off-by: Joe Richey <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation for the GDT often confuses entries and
Descriptors.For example, adding a new
Descriptoruses a method confusingly namedadd_entry.An entry is a raw 64-bit value that is indexed by a segment selector.
The
MAXlength of the GDT is a number of entries, notDescriptors.To fix this confusion, this PR makes the following changes:
u64newtype calledEntry.GlobalDescriptorTabledocumentation to correctly useEntryorDescriptorwhere appropriate.add_entrytoappend.from_raw_slicetofrom_raw_entriesas_raw_slicetoentriesEntrys instead ofu64sThis also fixes an issue where our
assert!s inempty()wouldn'ttrigger if the GDT was constructed from raw values.
Signed-off-by: Joe Richey [email protected]